home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / wsmenu.arc / WSMENU.DOC < prev   
Encoding:
Text File  |  1985-04-08  |  12.9 KB  |  265 lines
  1.  
  2.  
  3.  
  4.                                   WSMENU Version 2.5
  5.                      Documentation version 2.5 -- April 8, 1985   
  6.  
  7.                             MENU PATCHER FOR WORDSTAR V3.3 *
  8.  
  9.                                  For the IBM PC/XT/AT
  10.  
  11.                                           by
  12.  
  13.                                   James D. Gainsley
  14.                                  116 Third Avenue N.
  15.                                 Minneapolis, MN 55401
  16.                                     (612) 338-6124
  17.                                CompuServe [76703,1007]
  18.  
  19.                                Copyright (C) 1984, 1985
  20.  
  21.  
  22.          *****************************************************************
  23.          *                                           tm                  *
  24.          *                      U S E - M E - W A R E                    *
  25.          *                                                               *
  26.          *         If you use this program and find it of value, a       *
  27.          *           contribution of $10.00 will be appreciated.         *
  28.          *                                                               *
  29.          *                          LICENSE NOTICE                       *
  30.          *                                                               *
  31.          *  You are encouraged to copy and share this program with       *
  32.          *  others, on the conditions that the program is not modified,  *
  33.          *  that no fee or consideration is charged, including 'disk     *
  34.          *  copying fees', and that this documentation accompanies the   *
  35.          *  main program, WSMENU.COM.                                    *
  36.          *                                                               *
  37.          *  There are no warranties either express or implied regarding  *
  38.          *  the use of this program, and all risks reside with the user. *
  39.          *                                                               *
  40.          *****************************************************************
  41.  
  42.  
  43.        GENERAL:
  44.  
  45.        This program is designed specifically for altering the 7 menus in 
  46.        WordStar version 3.3.  The 7 menus are contained in the WordStar file, 
  47.        WSMSGS.OVR, which must be accessible to this program.  These menus are:
  48.  
  49.                                  OPENING MENU
  50.                                  MAIN MENU
  51.                                  QUICK MENU      (^Q)
  52.                                  BLOCK MENU      (^K)
  53.                                  PRINT MENU      (^P)
  54.                                  ONSCREEN MENU   (^O)
  55.                                  HELP MENU       (^J)
  56.  
  57.        A selected menu will be displayed on the upper portion of the screen.  
  58.        The user may then use the usual text editing functions, except Insert 
  59.        and Delete, to make any changes desired.  The characters than can be 
  60.        entered are those having ASCII codes between 32 and 126, plus ASCII 02 
  61.        and 05, 23, 24, 25.  Codes 24 & 25, the up and down arrows, are handy 
  62.        for indicators.  A hi-lighting feature is also provided.
  63.  
  64.  
  65.  
  66.  
  67.          WSMENU Version 2.5 Documentation Version 2.5             Page  -2-
  68.  
  69.  
  70.        After editing is completed, the new menu may be saved either to its 
  71.        place in the WSMSGS.OVR file, or to a separate file by itself. Prior 
  72.        to saving, the menu is printed on the bottom half of the screen, as it 
  73.        will actually be saved.  This will NOT necessarily be as it will 
  74.        APPEAR in WordStar.
  75.  
  76.        A menu may be selected either from the WSMSGS.OVR file, or from a 
  77.        special file previously prepared from this program.  It is possible to 
  78.        maintain a library of menus for use in various situations, which can 
  79.        quickly be placed into WordStar.
  80.  
  81.        The program is menu driven and mostly self-documenting. 
  82.  
  83.  
  84.        OPERATIONAL CHARACTERISTICS AND CAVEATS
  85.  
  86.        The actual number of bytes, which include "blank" spaces, comprising 
  87.        the menu may not be increased or decreased.
  88.  
  89.        The actual number of bytes per line of a menu may not be increased or 
  90.        decreased.  The end of each line except the last line, is indicated by 
  91.        ASCII 14, a double musical note symbol, which may not be edited.
  92.  
  93.        Some WordStar menus contain three-character sets consisting of ASCII 
  94.        05,nn,02, where nn is a character between ASCII 32 and 126.  These 
  95.        sets allow WordStar to print within the menu "now ON " and "now OFF".
  96.  
  97.        IT IS VERY IMPORTANT THAT THESE SETS NOT BE ALTERED, AND THAT THEY 
  98.        REMAIN WITH THE DESCRIPTION TO WHICH THEY ORIGINALLY APPLIED.  
  99.  
  100.        Because a line cannot be altered in length, these sets may be 
  101.        interchanged along with their descriptions, with other sets and their 
  102.        descriptions, but they may not be put on lines where no such set 
  103.        previously existed.  Also, they may not be put on lines where the 
  104.        effect will be to increase the number of such sets on the line.  The 
  105.        effect of doing so, will be to extend the line when called by 
  106.        WordStar, which will misalign the menu.  This happens because the 
  107.        legends which they represent, i.e. "  now ON " & "  now OFF", are 9 
  108.        characters long, while the sets are only 3 characters long.
  109.  
  110.        If the number of such sets on a line are reduced, then the number of 
  111.        characters on the line, when called by WordStar, will be reduced, 
  112.        which will cause misalignment if care is not taken. 
  113.  
  114.        The user is strongly advised to practice at first with a copy of 
  115.        WordStar in order to observe the effects of editing these sets.
  116.  
  117.        The only other character which could cause a problem if manipulated 
  118.        improperly, is the ACSII 23 an up/down underlined arrow, which appears 
  119.        only in the Opening Menu, and which controls the location of the 
  120.        STOP/CONTINUE print legend.
  121.  
  122.        Except for improper manipulation of these 3-character sets and the 
  123.        ASCII 23, no editing or saving function will adversely affect the 
  124.        operation of WordStar.
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.          WSMENU Version 2.5 Documentation Version 2.5             Page  -3-
  134.  
  135.  
  136.        EDITING KEYS:
  137.  
  138.        Cursor control keys, except PgUp, PgDn, DEL, INS, TAB, and the Control 
  139.        key functions associated with them. Note that the ENTER key does NOT 
  140.        insert a carriage return in the menu, which is not allowed. The 
  141.        Backspace key provides a destructive backspace function.  Actual 
  142.        deletion or insertion of characters is not allowed.  To blank a 
  143.        character at the cursor position or at the last editable position of 
  144.        each line, use the space bar.
  145.  
  146.        F1 = Toggle. Causes any entered character to be hi-lighted.  WARNING: DO 
  147.             NOT USE WHEN ENTERING ASCII 02, 05, 23 !!!
  148.  
  149.        F2 = Prints ASCII 02  (Third Character of 3-character sets.)
  150.  
  151.        F3 = Prints ASCII 23
  152.  
  153.        F5 = Prints ASCII 05  (First Character of 3-character sets.)
  154.  
  155.        F9 = Exits the EDIT mode and proceeds to first stage of SAVE routine.
  156.  
  157.        ESC = Terminates EDIT and initiates first stage of program termination.
  158.  
  159.        All menus consist of 8 screen lines of varying lengths, which are 
  160.        reproduced on the first 8 lines of the screen.  The cursor can be 
  161.        freely moved within this total area.  Editing may be done only within 
  162.        the 8 lines and to the left of the end of line marker, ASCII 14, and 
  163.        the ASCII 0 or nul character, which is the last character of the last 
  164.        line, but is not indicated visually during the edit mode. (It is shown 
  165.        on the pre-save template.)
  166.  
  167.                              *************************
  168.  
  169.                                   W A R N I N G !!
  170.  
  171.        THIS PROGRAM READS ROWS 1 THRU 8 ON THE SCREEN.  THEREFORE, ANY 
  172.        PROGRAM WHICH WRITES TO THIS AREA WHILE THIS PROGRAM IS RUNNING WILL 
  173.        BE READ AS PART OF THE MENU TO BE SAVED.  To avoid possible problems 
  174.        and unecessary rework, it is advisable to disable such programs before 
  175.        editing.  The only part of a menu which cannot be edited is the ASCII 
  176.        14, (end of line), character, and the zero (nul), which is the last 
  177.        character of the last line.  However, the program ALWAYS preserves 
  178.        these characters, even though they may not appear on the 'to be saved
  179.        template', so they need not be of concern in any event.  
  180.  
  181.        After the editing portion is completed, a template of the new menu is 
  182.        printed on the bottom portion of the screen.  This shows generally how 
  183.        the menu will appear in WordStar.  The 3-character sets are replaced 
  184.        with "  now OFF", and the space between 'now' and 'OFF' should contain 
  185.        the same character as in the 3-character original set, in each case.  
  186.        The word "OFF" has been used only for clarity.  Whether the word OFF or 
  187.        ON actually appears in WordStar, depends upon WordStars settings.  
  188.        Note that both "OFF" and "ON " are given 3 spaces in WordStars menu 
  189.        formatting.  Also, "  now" is always preceded by 2 spaces.  Note that 
  190.        end-of-line markers & the final '0' will always be in the same column.  
  191.        If that is ever NOT the case then an error has occured -- DO NOT SAVE 
  192.        THE MENU!!  If an end-of-line character, ASCII 14 is missing, is need 
  193.        be of no concern, since the program replaces all of them and the final 
  194.        0, physically in the file.
  195.  
  196.  
  197.  
  198.  
  199.          WSMENU Version 2.5 Documentation Version 2.5             Page  -4-
  200.  
  201.  
  202.        Until you become familiar with the program operation, it is 
  203.        recommended that the following general procedure be used.
  204.  
  205.        Place a copy of the three WordStar files, WS.COM, WSMSGS.OVR, and 
  206.        WSOVLY1.OVR, on a disk, together with WSMENU.  Make the drive 
  207.        containing the disk, the default drive (drive A: is suggested).
  208.  
  209.        Run the program and edit the desired menu, saving it back to the 
  210.        WSMSGS.OVR file, (WSMENU, Option 1.)  Then run the WordStar program on 
  211.        the disk. Call the menu.  If it meets your needs then exit WordStar 
  212.        and run WSMENU again, this time choosing Option 2,  Save to a Separate
  213.        File. As soon as the menu is presented, press F9 and save the menu, 
  214.        which will then be saved to a Separate file.
  215.  
  216.        After the saving process, you are given an option to Do More Menus.  
  217.        Choose this and then choose Option 3, Edit a Separate File and Save to 
  218.        a WSMSGS.OVR file.  Then simply give the name of the Separate file and 
  219.        follow the program prompts to copy it to the actual file you wish to 
  220.        modify.  This is of course a somewhat slower process, but it does 
  221.        insure against errors.
  222.  
  223.        MISCELLANEOUS:
  224.  
  225.        Drives A-F are supported and the colon need not be entered, however, 
  226.        no path or sub-directory support is provided.  All file handling will 
  227.        be done to the current directory on the drive selected.
  228.  
  229.        WSMENU.COM, WSMSGS.OVR, and menu libraries (if any), need not be on 
  230.        the same drive.
  231.  
  232.        It does not matter if you have renamed the file WSMSGS.OVR.  You are 
  233.        given the opportunity to enter the filename you are now using.
  234.  
  235.        If you choose to create separate menu files, you may use any valid DOS 
  236.        filename, but of course no path designation.
  237.  
  238.        To run the program, type WSMENU<cr> at the DOS prompt.  To bypass the 
  239.        license notice, simply press the space bar.  If not bypassed, press 
  240.        any key after the display.  In any event, program will proceed after 
  241.        the license notice has displayed for about 5 seconds.
  242.  
  243.        Format for entering filespecs. Note that the dot must be entered. Paths 
  244.        are not allowed. (d: = drive)
  245.  
  246.                           [d:]filename.[ext]
  247.  
  248.        The following table gives the locations of menus in the WSMSGS.OVR file.
  249.              ============================================================
  250.                                      Debug Addresses (hex)    Total Bytes 
  251.                  MENU                     Start   Finish        (decimal)
  252.              ------------------------------------------------------------
  253.                OPENING  . . . . . . . . .  04b2     06ff            590
  254.                MAIN     . . . . . . . . .  0a15     0c94            640
  255.                QUICK    . . . . . . . . .  1197     1416            640
  256.                BLOCK    . . . . . . . . .  15f5     1868            628
  257.                PRINT    . . . . . . . . .  19f4     1c73            640
  258.                ONSCREEN . . . . . . . . .  1df2     2041            592
  259.                HELP     . . . . . . . . .  2242     24aa            617
  260.              ------------------------------------------------------------
  261.        * WordStar is the Registered Trademark of MicroPro International Corp.
  262.  
  263.  
  264.  
  265. ----------------------------------